Skip to content

docs: use VitePress#4

Merged
marinofranz merged 2 commits intomainfrom
docs/vitepress
Oct 29, 2025
Merged

docs: use VitePress#4
marinofranz merged 2 commits intomainfrom
docs/vitepress

Conversation

@marinofranz
Copy link
Copy Markdown
Member

Description

Replaces default TypeDoc documentation with VitePress
Still uses TypeDoc for markdown generation but is then used in VitePress

Type of Change

  • 📚 Documentation update

Changes Made

  • replaced typedoc with vitepress
  • adjusted publish workflow
  • added script to generate the sidebar configuration for vitepress

Testing

  • All existing tests pass (pnpm test)
  • Tested manually (describe below)

Manual Testing

New documentation was tested in the browser
chrome_aKHDMN0DJW

Code Quality

  • My code follows the project's coding style
  • I have run pnpm lint and fixed any issues
  • I have run pnpm format to format my code
  • I have run pnpm typecheck and there are no type errors
  • I have reviewed my own code

Documentation

  • I have updated the relevant documentation (if applicable)

Screenshots/Recordings

chrome_koKJAhB7Ed chrome_UgAaWNTFKn

Checklist


@marinofranz marinofranz self-assigned this Oct 29, 2025
@marinofranz marinofranz added the documentation Improvements or additions to documentation label Oct 29, 2025
@marinofranz marinofranz marked this pull request as ready for review October 29, 2025 01:50
@codecov
Copy link
Copy Markdown

codecov bot commented Oct 29, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@marinofranz marinofranz merged commit d4838fe into main Oct 29, 2025
8 checks passed
@marinofranz marinofranz deleted the docs/vitepress branch October 29, 2025 01:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant